home *** CD-ROM | disk | FTP | other *** search
/ Just Call Me Internet / Just Call Me Internet.iso / com / othernet / fidonet / mfreq200 / maxifreq.doc < prev    next >
Text File  |  1995-10-15  |  10KB  |  250 lines
  1. *******   Maxi*FREQ 2.00<beta>
  2. *******   original work by Erik Williams of
  3. *******   SunFox Productions, Ltd. <Durham, NC>
  4. *******   Versions since 2.00 by Bill Scull
  5. *******   (c) Copyright, 1993-1995 All rights reserved.
  6.  
  7.                      PRELIMINARY DOCUMENTATION
  8.  
  9. LAST MODIFIED:  October 15, 1995
  10.  
  11. FILES IN ARCHIVE:
  12.  
  13.    MAXIFREQ.TOS => the executable
  14.    MAXIFREQ.CFG => config file...must be in Maxi*FREQ's directory!
  15.    MAXIFREQ.DOC => this documentation
  16.    SPEC_OK.TXT  => Sample spec_ok file
  17.    SPEC_OK.FTR  => Sample Trailer file
  18.  
  19. INTRODUCTION:
  20.  
  21. It will generate the OKFILE used by BinkleyTerm to aid in speeding up
  22. the file request process. 
  23.  
  24. Anyone who has used FREQLIST by Steve Barnes will know exactly
  25. what Maxi*FREQ does...
  26.  
  27. CONFIGURING THIS BUGGER:
  28.  
  29. Configuring Maxi*FREQ to do as you wish is relatively simple...MAXIFREQ.CFG
  30. is pretty much free-format in terms of spacing...feel free to indent as you
  31. wish...Maxi*FREQ's parser isn't fazed by block-style lines.  In fact, I
  32. highly encourage a block-format...it makes reading and fixing the config
  33. file that much easier!  A sample of this is the MAXIFREQ.CFG I have 
  34. included in this archive.
  35.  
  36. REQUIRED CONFIGURATION LINES:
  37.  
  38. LogFile <path and filename of log>
  39.  
  40.           ex.  LogFile g:\logs\maximove.log
  41.  
  42.     LogFile is simply the path and filename that you wish the logging to
  43. be written to.  I use the standard Binkley logging format, so you can use
  44. your main log or one of your choosing...either way is fine.
  45.  
  46. GenFreqLists <day{|day}...> <start time> <end time>
  47.  
  48.     This keyword controls the times that your system will generate the
  49. FREQ lists.  Most people tend to do this either on a daily basis at
  50. a certain time or once a week when they do their weekly batch processing.
  51.  
  52.        The <day> parameter can be any one or a combination of the following
  53.        options:
  54.  
  55.              Mon = Monday
  56.              Tue = Tuesday
  57.              Wed = Wednesday
  58.              Thu = Thursday
  59.              Fri = Friday
  60.              Sat = Saturday
  61.              Sun = Sunday
  62.              Week = Monday through Friday
  63.              WeekEnd = Saturday and Sunday
  64.              All = All seven days
  65.  
  66.        The days are case-sensitive, so please use these abbreviations
  67.        exactly as you see them.  If you wish to use more than one of these
  68.        days then join them together using the "|" character with *NO*
  69.        spaces in the specification.  For example:  Mon|Wed|Fri
  70.  
  71.        The <start_time> and <end_time> are twenty-four hour representations
  72.        of your starting and ending times respectively.  Each of these will
  73.        be eight characters long in the following format using the *MILITARY*
  74.        time scheme:
  75.  
  76.               hh:mm:ss
  77.  
  78.        It is essential that you follow this format exactly or my time
  79.        comparison routines may have unexpected results.  So, for example,
  80.        if you want a start time of 4:30p on the dot, just put in 16:30:00
  81.        for <start_time>.
  82.  
  83.        A word of warning:  you need to keep your times from crossing over
  84.        the midnight boundary or else unpredicted results may come of it.
  85.  
  86.  
  87. OKFile <path and filename>
  88.  
  89.     The OKFile parameter is the path and filename of the file used by
  90. BinkleyTerm as a keeper of the MAGICK names and the paths of the files.
  91. It will usually be some variant of OKFILE.* and the path and filename
  92. should be the same as given in the Okfile statement in BINKLEY.CFG.
  93.  
  94. FREQList <path and filename>
  95.  
  96.    NOTE: This will be ignored if the OCTOPUS keyword is present, also
  97.          it currently will not work. Was intended for FoReM/Turbo BBS's
  98.          and some of that code has been removed..
  99.  
  100.     This is the path and filename of the file that is generated by
  101. Maxi*FREQ.  This is the straight text listing of all of the files
  102. plus description, size, etc. that are placed in your OKFile.
  103.  
  104. BannerFile <path and filename>
  105.  
  106.      This is the path and filename of your text file that describes your
  107. BBS...it should be the same as the path and filename used in the About
  108. statement in BINKLEY.CFG.
  109.  
  110. SpecialOKs <path and filename>
  111.  
  112.      This is a listing of magick names and paths that you wish to be
  113. available in your OKFile at all times, even if they aren't files that
  114. are in your regular download areas.  It's also a way of making special
  115. magick names for an area that you don't normally want magick names to
  116. be used.
  117.  
  118. Trailer <path and filename>
  119.  
  120.     This will be appended at the end of your OKFILE. Usefull if the
  121. other end used a wildcard in the FREQ.
  122.  
  123. Octopus
  124.  
  125.      This enables the program to ignore the FILES.BBS, FILES.HAS and
  126. FILES.BAK when creating the OKfile. It also disallows the Freqfile.
  127.  
  128.      A general form of a line for the OKFILE is like:
  129.  
  130. @<magick name> <path and filename>
  131.  
  132.      and an example of it is:
  133.  
  134. @MAXIFREQ C:\TURBO\BINK\MISC\MAXIFREQ.ZIP
  135.  
  136.      The most useful feature of SpecialOKs is to password protect certain
  137. files that aren't in your download areas.  For example, I have source
  138. code for the Maxi* programmes that I wish to share with other programmers
  139. of my choice...all I have to do is give them a password to use when 
  140. grabbing the files from my system.  Then, I just add a line like this to
  141. my SpecialOKs file:
  142.  
  143. @MFREQSRC !HOSER C:\TURBO\BINK\SOURCE\MFREQSRC
  144.  
  145.      The critical part here is the !<password>...it will always be the
  146. second parameter in the OKFILE listing if a password is present.
  147.  
  148.      The SpecialOKs file is not parsed for accuracy, it is just copied
  149. over as-is before any other entries are added so make sure that your
  150. syntax is exactly correct.  When in doubt, consult your BinkleyTerm
  151. manual!  :)
  152.  
  153. Archiver <path and filename>
  154.  
  155.      This is the full path to your archiver of choice.  If specified,
  156. it will be used to archive the file given for FREQList into a smaller
  157. file for the convenience of sysops FREQing FILES from you.
  158.  
  159. ArcParams <add command> {options} <dest. path and archive name> <source
  160.            path and filename>
  161.  
  162.      This is the command string that will be sent to your archiver.  The
  163. best way of explaining it is to give an example for ST-ZIP 2.3 as my
  164. archiver of choice:
  165.  
  166.      ArcParams  -aei g:\turbo\bink\sunfox.zip g:\turbo\bink\sunfox.txt
  167.  
  168.      ST-ZIP allows me to stack the commands in one word, so I don't need
  169. the {options} field.  I want an archive named SUNFOX.ZIP created (or
  170. updated) in the g:\turbo\bink\ folder.  Generally, your source path and
  171. file name will be exactly the same as the one specified for your FREQList
  172. parameter, but you may add a space between the path and the filename if
  173. your archiver requires it (like Quester's LZH, for instance).  In this
  174. example, my source path and filename is exactly the FREQList parameter.
  175.  
  176.      If you archive your FREQList text file, make sure that your Avail
  177. keywords in BINKLEY.CFG point to this archive file rather than the
  178. text file as I blow away the raw text listing in favour of the archived
  179. listing.
  180.  
  181. FILEAREAS:
  182.  
  183.      Each of your download directories should have a FileArea...
  184. EndFileArea pair associated with it that tells Maxi*FREQ all about your
  185. download areas.
  186.  
  187.      Each FileArea must have the following directives:
  188.  
  189. Desc <description>
  190.  
  191.      This is your name for the file area limited to 45 characters!
  192.  
  193. MagickNames
  194.  
  195.      If you wish filenames to be available for FREQ without the other
  196. sysop having to remember what the extender of the file is, then choose
  197. this option.  It will truncate the "magick name" of the file to eight
  198. characters or less.  For example, ATARINET.ZIP would be available for
  199. FREQ with ATARINET as the "magick name".
  200.  
  201. NoMagickNames
  202.  
  203.      If you wish the full filename to be the "magick name", then choose
  204. this option.  This is desirable if (for instance) you keep several copies
  205. of the AtariNet nodelist in one of your download areas...each of which has
  206. the last two digits of the julian date of the nodelist creation as part of
  207. its extender (i.e. ATARLIST.A38).
  208.  
  209. (NOTE:  Choose only MagickNames or NoMagickNames...not both!)
  210.  
  211. Paths...EndPaths
  212.  
  213.      A Paths...EndPaths block is used to set off your DLareas.  Most
  214. FoReM/Turbo systems have their DL areas spread over several partitions,
  215. so each partition will need a DLarea directive.
  216.  
  217. DLarea <path of DL area> <.DIR file name>
  218.  
  219.      The DLarea directive lists each path and the .DIR file to be found
  220. in that path.  You may have as many of these as you wish in a Paths...
  221. EndPaths pair (indeed, as many as your computer's memory will permit).
  222. The sample configuration should make the syntax a bit more obvious.
  223.  
  224. Remember to end your FileArea definition with an EndFileArea.  Repeat for
  225. all of your download areas (again, the sample config file will show you
  226. this).
  227.  
  228. FINAL COMMENTS:
  229.  
  230. That should about do it...admittedly, the code is still a bit rough, but
  231. in weeks of testing, it's done the job here.  It works on the TT030 and
  232. the Mega4STE with TOS 3.06 and TOS 2.06, respectively.  These two machines
  233. are *THE* torture test of my programmes...so they should run on anything.
  234.  
  235. Any comments/bug reports you may have, please let me know so I can fix them.
  236. I'm usually in Fayetteville (NC) from Friday morning to Sunday evening and
  237. I will be back at the apartment on Monday morning at 6a (I work nights
  238. from Sunday to Thursday).
  239.  
  240. SunFox
  241.  
  242. Updated to be able to support Octopus and other BBS's by Bill Scull. 
  243. Please note that most of the FoReM/Turbo BBS code has been removed. It 
  244. can still create an OKfile for those, but will not create a list of the
  245. available files. 
  246.  
  247. Please send bug reports to me at 1:363/112.0@fidonet.org,
  248. 51:1/0.0@atarinet.ftn, 808:200/0.0@musicnet.ftn or 90:301/12.0@nest.ftn
  249.  
  250.